Range

Function

This API is used to get parameter range for AI > Setup > Crowd Density Detection page.

Note:

The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.

Request Message

Parameter Description

Table 1

ParameterRangeTypeDescription
channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…” WIFI_CH1x”
The number of channels depends on the capability of the device.
string arrayEach array bit represents a channel with a string.
DVR/NVR need.
IPC only uses CH1
page_type“ChannelConfig”,
“AlarmConfig”
stringData used to distinguish between the channel configuration page and the alarm configuration page

Sample:

POST /API/AI/Setup/CD/Range HTTP/1.1
{
    "version": "1.0",
    "data": {"page_type": "ChannelConfig"}
}

Response Message

Parameter Description

Table 2

ParameterRangeTypeDescription
channel_infoJSON objectSingle Channel Information JSON show as follow Table x
page_type“ChannelConfig”,
“AarmConfig”
stringThe data used to distinguish between the channel configuration page and the alarm configuration page is only needed when setting
channel_maxintMaximum number of channels

Table x

ParameterRangeTypeDescription
CH1Json ObjectJSON show as followTable 3
...Json Object
IP_CH1Json Object
...Json Object
WIFI_CH1Json Object
...Json Object

Table 3

ParameterRangeTypeDescription
status"Offline","Online",
“Nonsupport”
stringChannel online status, only for digital channels.
Note:This field does not exist when the channel is online
alarm_out“Local->1”…
”Local->x”
“IP_CH1->1”…
“IP_CH1->2”…
” IP_CHx->1”
” IP_CHx->2”
The number of channels depends on the capability of the device.
arrayAlarm output channel
Each array bit represents aalarm output channel with a string.
Camera:
Local->1:open,NULL:close
latch_time"10","20","40",
"60"
stringAlarm output time
record_enableture,falseboolRecording channel switch
post_recording"30","60","120",
"300"
stringVideo delay time
send_emailtrue, falseboolOutgoing mail switch
ftp_picture_uploadtrue, falseboolSend mail switch Channel Capture FTP Upload switch (dedicated to NVR)
ftp_video_uploadtrue, falseboolChannel video FTP upload switch (NVR special)
picture_to_cloudtrue, falseboolImage upload switch (NVR only)
light_linkagetrue, falseboolAlarm linkage switch
switchtrue, falseboolswitch,false: close
true: open
sensitivity1-4intDetection sensitivity
min_pixel64-1080intMinimum pixel value
max_pixel320-1080intMaximum pixel value
iva_lines0 not draw lines
1 draw lines
intPreview and play back whether lines will appear
detection_range"FullScreen"
"Customize"
stringdetection range
/0:full screen mode,1:Custom mode/
rule_infoObjectInformation JSON show as followTable 4
schedule_enableboolSchedule mode
ptz_operation_supportboolBall machine use supports ptz operation
enforcerlight_linkageboolRed and blue indicator linkage alarm
siren_linkageboolAlarm sound linkage alarm
http_listeningboolhttp event push
scheduleObjectThe following table is displayed, as shown in the following Table 7
default_timeout1-120000intSession timeout(range use)

Table 4

ParameterRangeTypeDescription
rule_number1ObjectRule number 1,Information JSON show as followTable 5
rule_number2ObjectRule number 2,Information JSON show as followTable 5
rule_number3ObjectRule number 3,Information JSON show as followTable 5
rule_number4ObjectRule number 4,Information JSON show as followTable 5

Table 5

ParameterRangeTypeDescription
rule_switchtrue, falseboolRegular switch
rule_rectObjectoctagon,Information JSON show as followTable 6

Table 6

ParameterRangeTypeDescription
x10-704shortx1 coordinate point
y10-576shorty1 coordinate point
x20-704shortx2 coordinate point
y20-576shorty2 coordinate point
x30-704shortx3 coordinate point
y30-576shorty3 coordinate point
x40-704shortx4 coordinate point
y40-576shorty4 coordinate point
x50-704shortx5 coordinate point
y50-576shorty5 coordinate point
x60-704shortx6 coordinate point
y60-576shorty6 coordinate point
x70-704shortx7 coordinate point
y70-576shorty7 coordinate point
x80-704shortx8 coordinate point
y80-576shorty8 coordinate point

Table 7

ParameterRangeTypeDescription
schedule_type"SendEmail"
"FtpPicUpload"
"CloudPicUpload"
"Record"
"AlarmOut"
"FtpVdUpload"
"CloudVdUpload"
"FloodLight"
"Siren"
"EnforcerLight"
stringSchedule type
weekObejctWeekly information is shown in the table Table 8

Table 8

ParameterRangeTypeDescription
day"Sun"
"Mon"
"Tue"
"Wed"
"Thu"
"Fri"
"Sat"
stringday
timeinttime

Tips:

The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "channel_max": 1,
        "channel_info": {
            "type": "object",
            "items": {"CH1": {
                "type": "object",
                "items": {
                    "status": {
                        "description": "Only offline channel has this variable.",
                        "type": "string",
                        "mode": "r",
                        "items": [
                            "Offline",
                            "Online",
                            "Nonsupport"
                        ]
                    },
                    "switch": {"type": "bool"},
                    "sensitivity": {
                        "type": "int32",
                        "items": [
                            1,
                            2,
                            3,
                            4
                        ]
                    },
                    "min_pixel": {
                        "type": "int32",
                        "mode": "r",
                        "min": 32,
                        "max": 1080,
                        "default_value": 32
                    },
                    "max_pixel": {
                        "type": "int32",
                        "mode": "r",
                        "min": 320,
                        "max": 1080,
                        "default_value": 640
                    },
                    "max_detection_num": {
                        "type": "int32",
                        "mode": "r",
                        "min": 1,
                        "max": 500,
                        "default_value": 50
                    },
                    "detection_range": {
                        "type": "string",
                        "items": [
                            "FullScreen",
                            "Customize"
                        ]
                    },
                    "rule_info": {
                        "type": "object",
                        "items": {"rule_number1": {
                            "type": "object",
                            "items": {
                                "rule_switch": {"type": "bool"},
                                "rule_rect": {
                                    "type": "object",
                                    "items": {
                                        "x1": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x2": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x3": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x4": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x5": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x6": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x7": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "x8": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 704
                                        },
                                        "y1": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y2": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y3": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y4": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y5": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y6": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y7": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        },
                                        "y8": {
                                            "type": "int32",
                                            "min": 0,
                                            "max": 576
                                        }
                                    }
                                }
                            }
                        }}
                    }
                }
            }}
        }
    }
}

Error Code

See Response Messages Body and Common error_code for more information.